home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / tex / shells / rtexsh13.zoo / readme.rtx < prev    next >
Encoding:
Text File  |  1991-11-27  |  9.9 KB  |  191 lines
  1. Program        : RTeXShell (RTEXSH13.PRG)
  2. Version        : 1.3
  3. Release Date   : 26th November, 1991.
  4. Status         : Public Domain. 
  5. Conditions     : Free. 
  6.                  No restrictions on public distribution as long as
  7.                  the distribution package contains RTEXSH13.PRG, 
  8.                  RTEXSH13.CFG, README.RTX, ENVIRON files. 
  9.                  No responsibility, direct or indirect, is assumed.
  10.                  
  11.  
  12. Readme File For RTeXShell Version 1.3 :
  13.  
  14. RTeXShell is a graphical shell running under GEM on the ATARI ST computer.
  15. It's primary goal is to simlify the running of TeX typesetting program on 
  16. ST. It is assumed here that the user has sufficient knowledge to run and 
  17. use TeX on the ST. TeX for ATARI ST is available from atari.archive.umich.
  18. edu and various other anonymous FTP sites and other sources. RTeXShell is
  19. primarily targeted to those users with limited computing resources & trying
  20. to run a minimal TeX system. Advanced & power users of TeX may look into
  21. CS-TeX recently uploaded to atari.archive.umich.edu. 
  22.  
  23. RTeXShell is modelled on Greg Lindahl's TeXShell (and TeXShel2) available
  24. at atari.archive.umich.edu and provides similar functionality. However,
  25. where TeXShell is really incomplete (Greg's own admission), RTeXShell is 
  26. more or less complete and hopefully free from bugs. RTeXShell does not
  27. impose any restrcition for the setting up of paths for various TeX system
  28. components (e.g., VIRTEX.TTP, format files, TFM files, PK or PXL files,
  29. Editor, Spell Checker, DVI drivers etc.). However, it is the user's duty
  30. to set up the proper environment variables for the successful implement-
  31. ation of TeX system. The public domain program ENVIRON.PRG available at
  32. atari.archive and also at pdsoft.lancs.ac.uk separately and also as part of 
  33. the SHOWDVI package can be used to achieve this.
  34.  
  35. Version 1.3 removes some bugs from the only other version (1.0) that was 
  36. publicly distributed. Most notable is the bug that forces the use of 
  37. RTeXShell only from the root directory. Apart from these some enhance-
  38. ments are also made. These include the inclusion of two user defined 
  39. entries in the Task menu and some helpfule indication when the file 
  40. selector is activated. Also in case the default configuration file 
  41. RTexSh13.CFG is not found, an alternate configuration file can also be 
  42. loaded. RTexSh13 (i.e. Version 1.3 of RTeXShell) can use the configura-
  43. tion file created by the earlier version as well.
  44.  
  45. RTeXSh13 provides the following TASK services :
  46.  
  47.    1. TeX             : Running plain TeX
  48.    2. LaTeX           : Running LaTeX
  49.    3. Edit            : Invoking your favourite editor
  50.    4. Spell Check     : If your editor does not have integrated spell checker
  51.    5. DVI Preview     : To preview the TeX output files on the screen
  52.    6. DVI Print       : To obtain hardcopy of TeX output file
  53.    7. User Defided 1  : Allows chaining to another program  
  54.    8. User Defined 2  : Allows chaining to another program
  55.  
  56. On startup, RTeXSh13 reads the file RTEXSH13.CFG which must be in the same 
  57. directory as the program itself. RTeXShell reads information regarding the
  58. location and command line options for the TeX system component programs. 
  59. The file RTEXSH13.CFG may have a maximum of eight lines with 80 characters 
  60. in each line maximum. Each line gives the full path description (also command 
  61. line option) of a program. The sequence given above for RTeXShell TASK services 
  62. must be strictly followed, i.e,
  63.  
  64.    Line 1   -> for TeX 
  65.    Line 2   -> for LaTeX
  66.    Line 3   -> for Editor
  67.    Line 4   -> for Spell Checker
  68.    Line 5   -> for DVI previewer
  69.    Line 6   -> for DVI printer
  70.    Line 7   -> for 1st User defined program
  71.    Line 8   -> for 2nd User defined program
  72.  
  73. If you don't have the program for any of the above TASK services (or don't
  74. want that service) leave the correspoding line blank or put a ';' at the 
  75. beginning of that line. Anything that appears after a ';' will be taken
  76. as a comment and will be discarded. Leading and trailing spaces in the
  77. lines are allowed.
  78.  
  79. Those with floppy only system have noticed that a full TeX system can not
  80. be packed into one disk and requires two disks. RTeXShell supports two 
  81. disks for such a situation. If any of the programs are on a second disk
  82. put a '%' just before the full path description of that program. When 
  83. that TASK option is invoked, RTeXShell will ask you to insert the second 
  84. (DVI drivers) disk. 
  85.  
  86. Version 1.3 of RTeXShell introduces another new special character. This
  87. is applicable only for the 2 user defined command lines. If the character
  88. '~' is present in either line 7 or 8 (or both) then the string following
  89. '~' will be taken as the file type of the command in question. Valid file
  90. type notations are '*.LOG', '*.ERR', '*.C', '*.B?' etc. Furthermore, only
  91. the first appearance of '~' will be preocessed and if there are more than 
  92. one '~' characters than the rest will not be considred. I am leaving this
  93. as the user's responsiblity to ensure that correct file types are written
  94. in the configuration file. If the command is question does not require any
  95. data file name to be passed then do not use this '~' character in that line.
  96.  
  97. A sample RTEXSH13.CFG file is given below :
  98.  
  99. >>>>>>>>>>>>>>>>>>>>>>>>>- START ->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
  100. A:\TEX\VIRTEX.TTP &plain      ; For Plain TeX 
  101. ;A:\TEX\VIRTEX.TTP &lplain    ; For LaTeX, now made inactive
  102.      A:\TEMPUS.PRG        ; Tempus Editor
  103.                               ; For Spell Checker, is inactive
  104. %A:\SHOWDVI.PRG -p -z 120     ; DVI Previewer, on separate disk 
  105.  %A:\DVIPRINT.TTP              ; DVI Pinter, on separate disk as well
  106. %A:\FLIB.TTP                   ; Run Fonts Librarian from 2nd disk
  107. A:\TEMPUS.PRG      ~*.LOG       ; Run TEMPUS with default file type '*.LOG' 
  108. >>>>>>>>>>>>>>>>>>>>>>>>>- END ->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
  109.  
  110. In the above configuration file, LaTeX and Spell checker is not made active
  111. and also DVI previewer and DVI printer programs are on a separate disk
  112. (media). The Font Librarian program FLIB.TTP rwesiding in the 2nd disk is
  113. chosen the first user defined program with no data files to be passed to it.
  114. TEMPUS.PRG with default data file type *.LOG is chosen as the 2nd user
  115. defined program. My own suggestion for the organisation of the TeX 
  116. programs for two disk system is as follows :
  117.  
  118. Disk 1 : Called TeX System disk : VIRTEX.TTP, PLAIN.FMT, TFM Files, Macros,
  119.                                   EDITOR etc.
  120. Disk 2: Called DVI drivers disk : SHOWDVI.PRG, DVIPRINT.TTP, PK Files etc.
  121.  
  122. Another sample RTEXSH13.CFG file for hard disk users.
  123.  
  124. >>>>>>>>>>>>>>>>>>>>>>>>>- START ->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
  125. C:\TEX\VIRTEX.TTP &plain       ; For Plain TeX 
  126. ;C:\TEX\VIRTEX.TTP &lplain     ; For LaTeX, now made inactive
  127.      D:\TEMPUS.PRG        ; Tempus Editor
  128.                                ; For Spell Checker, is inactive
  129. C:\TEX\SHOWDVI.PRG -p -z 120   ; DVI Previewer
  130.     C:\TEX\DVIPRINT.TTP              ; DVI Pinter driver
  131. C:\CLI\GU.PRG                   ; Chain to Gulam CLI
  132. D:\TEMPUS.PRG      ~*.LOG       ; Run TEMPUS with default file type '*.LOG' 
  133. >>>>>>>>>>>>>>>>>>>>>>>>>- END ->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
  134.  
  135.  
  136. A sample environment varaiable list for my own system is also given in this
  137. package (see file ENVIRON).
  138.  
  139. Finally, about file name conventions. RTeXShell uses a smart file name 
  140. convention and as such eases it's operation. *.TEX and *.DVI are the default
  141. file types. Suppose, you first choose the 'Edit' option and when asked about
  142. the file name you typed ABC.TEX. Now, if you chose 'TeX' option you will not be
  143. asked again for the file name and the file ABC.TEX will be passed to the TeX 
  144. program. On the other hand, if you choose 'DVI Preview (or Print)' option, the 
  145. file ABC.DVI will ne passed to the DVI driver program. The same logic applies 
  146. if you first choose the 'DVI Preview (or Print)' option. You can, however, 
  147. choose any file name extension other than *.TEX for the TeX source file. 
  148. However, in such cases the file type *.DVI will be assumed for the corresponding 
  149. DVI file. The same rule applies when a non *.DVI file type is chosen first. The
  150. purpose of this given smartness (or one can perhaps arguably call dumbness) is
  151. to free the user from entering file names for each stage of a complete TeX
  152. session. If you want to start working with a new file choose 'New Session' 
  153. from the 'Sundries' menu whereupon the current file name will be reverted to
  154. NULL. Default file types used in RTeXShell are as follows :
  155.  
  156.                 Task1           TeX             *.TEX
  157.                 Task2           LaTex           *.TEX
  158.                 Task3           Edit            *.TEX
  159.                 Task4           Spell           *.TEX
  160.                 Task5           DVI Preview     *.DVI
  161.                 Task6           DVI Printer     *.DVI
  162.                 Task7           User Defined 1  User Defined
  163.                 Task8           User Defined 2  User Defined
  164.  
  165.  
  166.  
  167. I'm using this program fairly regularly and am satisfied. The only bad thing
  168. about this program (RTeXShell) is that it is much larger in size than Greg's
  169. TeXShell. One of the reason for this is that I am using Prospero Pascal, not 
  170. the best compiler for tight code generation. I don't have any other compiler 
  171. handy. If there is sufficient interest and also I've some spare time & money 
  172. I'll try to rewrite it using Modula-2 or C and use an efficient compiler. 
  173.  
  174. That's all. 
  175.  
  176. Suggestions, criticism, bug reports, gifts etc. are all welcome.
  177.  
  178. Good luck and thanks to Prof. D. Knuth for giving us TeX.
  179.  
  180. - Rahin.
  181.  
  182. Mohammad A. Rahin           |   M.A.Rahin@lut.ac.uk     -> from outside UK
  183. 315, Forest Road            |   M.A.Rahin@uk.ac.lut     -> from within UK
  184. Loughborough                |
  185. LECIS LE11 3HT              | 
  186. U.K.                        |
  187.  
  188. ----------------------------------------------------------------------------
  189. * TeX is a trademark of Americal Mathematical Society.
  190.  
  191.